Added documentation to gtksizegroup.sgml explaining what happens with height-for...
authorTristan Van Berkom <tristan.van.berkom@gmail.com>
Tue, 14 Sep 2010 18:54:12 +0000 (03:54 +0900)
committerTristan Van Berkom <tristan.van.berkom@gmail.com>
Tue, 14 Sep 2010 19:04:02 +0000 (04:04 +0900)
When grouping height-for-width trading widgets (wrapping labels for instance)
vertically; the height for the minimum width will always be used for the entire
group... this patch warns about this in the docs.

docs/reference/gtk/tmpl/gtksizegroup.sgml

index 4bf90cec62770544cfd746006c277db4c0f2903c..4d6329fbf129275bc2849faae2d27ea19dbc383d 100644 (file)
@@ -44,6 +44,15 @@ vertical size from the vertical requisition of all widgets that can be
 reached from the widget by a chain of size groups of type
 %GTK_SIZE_GROUP_VERTICAL or %GTK_SIZE_GROUP_BOTH.
 </para>
+<para>
+Note that only non-contextual sizes of every widget are ever consulted
+by size groups (since size groups have no knowledge of what size a widget
+will be allocated in one dimension, it cannot derive how much height
+a widget will receive for a given width). When grouping widgets that
+trade height for width in mode %GTK_SIZE_GROUP_VERTICAL or %GTK_SIZE_GROUP_BOTH: 
+the height for the minimum width will be the requested height for all 
+widgets in the group.
+</para>
 <refsect2 id="GtkSizeGroup-BUILDER-UI">
 <title>GtkSizeGroup as GtkBuildable</title>
 <para>